home *** CD-ROM | disk | FTP | other *** search
/ Sprite 1984 - 1993 / Sprite 1984 - 1993.iso / man / cmds / jls.man < prev    next >
Text File  |  1992-09-01  |  9KB  |  327 lines
  1. '\"
  2. '\" Copyright 1992 Regents of the University of California
  3. '\" Permission to use, copy, modify, and distribute this
  4. '\" documentation for any purpose and without fee is hereby
  5. '\" granted, provided that this notice appears in all copies.
  6. '\" The University of California makes no representations about
  7. '\" the suitability of this material for any purpose.  It is
  8. '\" provided "as is" without express or implied warranty.
  9. '\" 
  10. '\" $Header: /user5/mottsmth/j/l/jls.man,v 1.8 92/05/07 09:02:14 mottsmth Exp $ SPRITE (Berkeley)
  11. '\" 
  12. .\" The definitions below are for supplemental macros used in Sprite
  13. .\" manual entries.
  14. .\"
  15. .\" .HS name section [date [version]]
  16. .\"    Replacement for .TH in other man pages.  See below for valid
  17. .\"    section names.
  18. .\"
  19. .\" .AP type name in/out [indent]
  20. .\"    Start paragraph describing an argument to a library procedure.
  21. .\"    type is type of argument (int, etc.), in/out is either "in", "out",
  22. .\"    or "in/out" to describe whether procedure reads or modifies arg,
  23. .\"    and indent is equivalent to second arg of .IP (shouldn't ever be
  24. .\"    needed;  use .AS below instead)
  25. .\"
  26. .\" .AS [type [name]]
  27. .\"    Give maximum sizes of arguments for setting tab stops.  Type and
  28. .\"    name are examples of largest possible arguments that will be passed
  29. .\"    to .AP later.  If args are omitted, default tab stops are used.
  30. .\"
  31. .\" .BS
  32. .\"    Start box enclosure.  From here until next .BE, everything will be
  33. .\"    enclosed in one large box.
  34. .\"
  35. .\" .BE
  36. .\"    End of box enclosure.
  37. .\"
  38. .\" .VS
  39. .\"    Begin vertical sidebar, for use in marking newly-changed parts
  40. .\"    of man pages.
  41. .\"
  42. .\" .VE
  43. .\"    End of vertical sidebar.
  44. .\"
  45. .\" .DS
  46. .\"    Begin an indented unfilled display.
  47. .\"
  48. .\" .DE
  49. .\"    End of indented unfilled display.
  50. .\"
  51. '\"    # Heading for Sprite man pages
  52. .de HS
  53. .if '\\$2'cmds'       .TH \\$1 1 \\$3 \\$4
  54. .if '\\$2'lib'        .TH \\$1 3 \\$3 \\$4
  55. .if '\\$2'tcl'        .TH \\$1 3 \\$3 \\$4
  56. .if '\\$2'tk'         .TH \\$1 3 \\$3 \\$4
  57. .if t .wh -1.3i ^B
  58. .nr ^l \\n(.l
  59. .ad b
  60. ..
  61. '\"    # Start an argument description
  62. .de AP
  63. .ie !"\\$4"" .TP \\$4
  64. .el \{\
  65. .   ie !"\\$2"" .TP \\n()Cu
  66. .   el          .TP 15
  67. .\}
  68. .ie !"\\$3"" \{\
  69. .ta \\n()Au \\n()Bu
  70. \&\\$1    \\fI\\$2\\fP    (\\$3)
  71. .\".b
  72. .\}
  73. .el \{\
  74. .br
  75. .ie !"\\$2"" \{\
  76. \&\\$1    \\fI\\$2\\fP
  77. .\}
  78. .el \{\
  79. \&\\fI\\$1\\fP
  80. .\}
  81. .\}
  82. ..
  83. '\"    # define tabbing values for .AP
  84. .de AS
  85. .nr )A 10n
  86. .if !"\\$1"" .nr )A \\w'\\$1'u+3n
  87. .nr )B \\n()Au+15n
  88. .\"
  89. .if !"\\$2"" .nr )B \\w'\\$2'u+\\n()Au+3n
  90. .nr )C \\n()Bu+\\w'(in/out)'u+2n
  91. ..
  92. '\"    # BS - start boxed text
  93. '\"    # ^y = starting y location
  94. '\"    # ^b = 1
  95. .de BS
  96. .br
  97. .mk ^y
  98. .nr ^b 1u
  99. .if n .nf
  100. .if n .ti 0
  101. .if n \l'\\n(.lu\(ul'
  102. .if n .fi
  103. ..
  104. '\"    # BE - end boxed text (draw box now)
  105. .de BE
  106. .nf
  107. .ti 0
  108. .mk ^t
  109. .ie n \l'\\n(^lu\(ul'
  110. .el \{\
  111. .\"    Draw four-sided box normally, but don't draw top of
  112. .\"    box if the box started on an earlier page.
  113. .ie !\\n(^b-1 \{\
  114. \h'-1.5n'\L'|\\n(^yu-1v'\l'\\n(^lu+3n\(ul'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul'
  115. .\}
  116. .el \}\
  117. \h'-1.5n'\L'|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul'
  118. .\}
  119. .\}
  120. .fi
  121. .br
  122. .nr ^b 0
  123. ..
  124. '\"    # VS - start vertical sidebar
  125. '\"    # ^Y = starting y location
  126. '\"    # ^v = 1 (for troff;  for nroff this doesn't matter)
  127. .de VS
  128. .mk ^Y
  129. .ie n 'mc \s12\(br\s0
  130. .el .nr ^v 1u
  131. ..
  132. '\"    # VE - end of vertical sidebar
  133. .de VE
  134. .ie n 'mc
  135. .el \{\
  136. .ev 2
  137. .nf
  138. .ti 0
  139. .mk ^t
  140. \h'|\\n(^lu+3n'\L'|\\n(^Yu-1v\(bv'\v'\\n(^tu+1v-\\n(^Yu'\h'-|\\n(^lu+3n'
  141. .sp -1
  142. .fi
  143. .ev
  144. .\}
  145. .nr ^v 0
  146. ..
  147. '\"    # Special macro to handle page bottom:  finish off current
  148. '\"    # box/sidebar if in box/sidebar mode, then invoked standard
  149. '\"    # page bottom macro.
  150. .de ^B
  151. .ev 2
  152. 'ti 0
  153. 'nf
  154. .mk ^t
  155. .if \\n(^b \{\
  156. .\"    Draw three-sided box if this is the box's first page,
  157. .\"    draw two sides but no top otherwise.
  158. .ie !\\n(^b-1 \h'-1.5n'\L'|\\n(^yu-1v'\l'\\n(^lu+3n\(ul'\L'\\n(^tu+1v-\\n(^yu'\h'|0u'\c
  159. .el \h'-1.5n'\L'|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\h'|0u'\c
  160. .\}
  161. .if \\n(^v \{\
  162. .nr ^x \\n(^tu+1v-\\n(^Yu
  163. \kx\h'-\\nxu'\h'|\\n(^lu+3n'\ky\L'-\\n(^xu'\v'\\n(^xu'\h'|0u'\c
  164. .\}
  165. .bp
  166. 'fi
  167. .ev
  168. .if \\n(^b \{\
  169. .mk ^y
  170. .nr ^b 2
  171. .\}
  172. .if \\n(^v \{\
  173. .mk ^Y
  174. .\}
  175. ..
  176. '\"    # DS - begin display
  177. .de DS
  178. .RS
  179. .nf
  180. .sp
  181. ..
  182. '\"    # DE - end display
  183. .de DE
  184. .fi
  185. .RE
  186. .sp .5
  187. ..
  188. .HS jls cmds
  189. .BS
  190. '\" Note:  do not modify the .SH NAME line immediately below!
  191. .SH NAME
  192. jls \- list contents of a Jaquith archive directory. 
  193. .SH SYNOPSIS
  194. \fBjls\fR  [\fB\-arch \fIarchive\fR]
  195. [\fB\-server \fIhostname\fR]  [\fB\-port \fIport\fR]
  196. [\fB\-range (\fIdate1\fR,\fIdate2\fR)]
  197. [\fB\-owner \fIname\fR] [\fB\-group \fIname\fR]
  198. [\fB\-abs \fIregexp\fR] [\fB-u]
  199. [\fB\-asof \fIdate\fR] [\fB\-since \fIdate\fR] 
  200. [\fB-first \fIn\fR] [\fB-last \fIn\fR] [\fB\-all\fR]
  201. [\fB\-moddate\fR] [\fIfilelist\fR]
  202. [\fB\-l\fR] [\fB\-i\fR] [\fB\-u\fR] [\fB\-a\fR] [\fB\-s\fR]
  203. [\fB-g\fR] [\fB\-d\fR] [\fB-R\fR] [\fB-raw\fR] 
  204. .SH OPTIONS
  205. .IP "\fB\-arch \fIarchive\fR" 14
  206. Name of logical archive.  If none is specified, the environment
  207. variable JARCHIVE is used, if defined, else the default archive
  208. is used.
  209. .IP "\fB\-server \fIhostname\fR" 14 
  210. Specifies host where Jaquith server is running. Defaults
  211. to the environment variable JSERVER.
  212. .IP "\fB\-port \fIport\fR" 14 
  213. Specifies port number where Jaquith server is running. Defaults
  214. to the environment variable JPORT.
  215. .IP "\fB\-range \fIdate1\fR,\fIdate2\fR" 14
  216. List files with date in specified range.
  217. .IP "\fB\-owner \fIname\fR" 14 
  218. List only files with specified owner name.
  219. .IP "\fB\-group \fIname\fR" 14 
  220. List only files with specified group name.
  221. .IP "\fB\-abs \fIregexp\fR" 14 
  222. List files which match \fIregexp\fR in their abstract lines.
  223. .IP "\fB\-asof \fIdate\fR
  224. List version which was current as of specified date. Equivalent to:
  225. \-range(1-jan-1970,\fIdate\fR)
  226. .IP "\fB\-since \fIdate\fR
  227. List versions between \fIdate\fR and present date. Equivalent to:
  228. \-range(\fIdate\fR,\fIpresent-date\fR)
  229. .IP "\fB\-first \fIn\fR
  230. List from the nth version in the date range.
  231. .IP "\fB\-last\fR
  232. List to the nth version in the date range.
  233. .IP "\fB\-all\fR
  234. List all the versions in the archive. Equivalent to: -first 1 -last -1
  235. .IP "\fB\-moddate\fR
  236. Use the file's modification date, not its archive date
  237. for all date comparisons.
  238. .IP "\fB\-l\fR" 14 
  239. Display using long format (see below).
  240. .IP "\fB\-i\fR" 14 
  241. Display buffer number where file lives, volume id where buffer lives,
  242. and position on volume of buffer.
  243. .IP "\fB\-u\fR" 14 
  244. Display archive date instead of last-modification date (with -l option).
  245. .IP "\fB\-a\fR" 14 
  246. Display abstract.
  247. .IP "\fB\-s\fR" 14 
  248. Display file size in 1024 byte units.
  249. .IP "\fB\-g\fR" 14 
  250. Display group name.
  251. .IP "\fB\-d\fR" 14 
  252. Display directory name only.
  253. .IP "\fB\-R\fR" 14 
  254. Display directory tree recursively.
  255. .IP "\fB\-raw\fR" 14 
  256. Display output in raw mode. This feature is undocumented,
  257. (you are NOT presently reading this) and is subject to change/removal.
  258. .BE
  259. .SH DESCRIPTION
  260. .PP
  261. \fBJls\fP provides a simple directory listing mechanism
  262. for an archive tape system controlled by the Jaquith program.
  263. .PP
  264. The primary argument \fIfilelist\fR is a  file expression
  265. which specifies the files to be listed.  Shell-like globbing
  266. is supported. '*' matches any number of characters. '?'
  267. matches a single character. Additionally, curly braces can
  268. be used to enclose alternatives. For example foo.{bak,?}
  269. matches foo.bak, foo.c and foo.h.
  270. .PP
  271. Note that any metacharacters which are
  272. not protected with a backslash or quotes will be expanded by the
  273. shell, not by the Jaquith system.
  274. .PP
  275. The default action is to list the simple filenames of the
  276. most recent versions of matching filenames.
  277. The set of files listed can be controlled by the use of
  278. one or more options.  The options are all logically ANDed
  279. together; only files matching all criteria are listed.
  280. .PP
  281. The -range, -first and -last options work together to specify
  282. a subset of the archived versions.  First, the date range is
  283. applied, resulting in a list of candidates numbered logically
  284. from 1 to \fIn\fR.  Then the first and last options are applied
  285. to this list. First and last can be positive and retrieve the
  286. specified filenames from restricted list, or they can be negative
  287. in which case they count from the end of the list. Thus, the
  288. most recent version of a file can be retrieved with 'first -1
  289. last -1' without having to know how many versions currently exist.
  290. .PP
  291. \fIdate\fR is of the form \fIDateSpec[:TimeSpec]\fR. \fITimeSpec\fR
  292. is of the form [hh[:mm[:ss]]], and \fIDateSpec\fR is of the form
  293. dd\(hymonth[\(hyyyyy]. Month is the first 3 letters of the month;
  294. all others are numbers. The '/' character is a substitute
  295. for '-' and '.' may be used instead of ':'.
  296. .PP
  297. By default jls simply lists the matching filenames, 1 per line.
  298. In long form jls generates:
  299. .IP
  300. \fImode ownerID size date filename\fR
  301. .PP
  302. With the \fB-i\fR option the "inode" information is included:
  303. .IP
  304. \fItBufId volId filemark mode ownerID size date filename\fR
  305. .PP
  306. \fIdate\fR is the archive date if the \fI-u\fR
  307. option is given, else it's the file's last modification date.
  308. .SH BUGS
  309. The option flags have little relation to the standard ls options.
  310. .PP
  311. No multicolumn formatting is provided.
  312. .PP
  313. A file which matches more than one regular expression will be
  314. listed multiple times.
  315. .PP
  316. Only one archive can be specified at a time.
  317. .PP
  318. Unlike the shell, the Jaquith globbing characters '*' and '?' match
  319. a '.' in the first position.
  320.  
  321. .SH "SEE ALSO"
  322. jaquith jmgr jstat jput jget jctrl jcopy jclean jbuild
  323.  
  324. .SH KEYWORDS
  325. jaquith archive
  326.  
  327.